CKYC PreUpload API

This document highlights the CKYC PreUpload API details:

Table of Contents

• Objective
• API URL
• Overview
• Authentication
• API Request Details
• Inputs
• Sample Request
• Success Response
• Error Responses

Objective

The CKYC PreUpload API is a prerequisite for the CKYC Upload API, facilitating the configuration and webhook setup required for HyperVerge to access the Central KYC Registry on behalf of your organization. This API enables the setup and storage of the following configurations for the client or financial institution on the HyperVerge platform:

• Organisation Name: The name of the organization as registered under the Central KYC Registry portal.
• FI Code: The unique identifier assigned to a financial institution upon its registration within the Central KYC Registry portal.
• Region Code: The unique code for a geographical region registered in the Central KYC Registry portal.
• WebhookUrl: The URL designated for receiving webhooks. This has be shared by client and this url will be used to send the response back.
• Username: The 'maker' username for the Central KYC Registry portal.
• Password: The 'maker' password for the Central KYC Registry portal.
• Host: The SFTP IP address provided by the Central KYC Registry.

These configurations are essential for connecting with CERSAI servers, enabling the CKYC Upload API to process upload requests based on the client's settings.

API URL

https://ind-ckyc.hyperverge.co/api/v1/config/upload

Overview

The API is RESTful and uses standard HTTP verbs and status codes. The responses are in JSON format.

Authentication

You need a unique pair of application ID (appId) and application key (appKey) from HyperVerge to verify your identity for accessing the API.

API Request Details

Method

POST - Use this method to provide the configuration for the first time.

PUT - Use this method to update an existing configuration already shared earlier.

Headers

Parameter	Mandatory or Optional	Description	Valid Values
content-type	Mandatory	This parameter defines the media type for the request payload.	application/json
appId	Mandatory	Application ID shared by HyperVerge	N/A. This is a unique value.
appKey	Mandatory	Application Key shared by HyperVerge	N/A. This is a unique value.
transactionId	Mandatory	Unique ID for the customer journey.	N/A. Any defined unique value mapped to a transaction in your business ecosystem.

Inputs

Parameter	Data Type	Mandatory or Optional	Description	Valid Values
organisationName	string	Mandatory	The name of the organization as registered under the Central KYC Registry portal.	Not Applicable
fiCode	string	Mandatory	The unique identifier assigned to a financial institution upon its registration within the Central KYC Registry portal.	Not Applicable
regionCode	string	Mandatory	The unique code for a geographical region registered in the Central KYC Registry portal.	Not Applicable
webhookUrl	string	Mandatory	The URL designated for receiving webhooks.	Not Applicable
username	string	Mandatory	The 'maker' username for the Central KYC Registry portal.	Not Applicable
password	string	Mandatory	The 'maker' password for the Central KYC Registry portal.	Not Applicable
host	string	Mandatory	The SFTP IP address provided by the Central KYC Registry.	Not Applicable

Sample Request

The following code shows the standard curl requests for the API.

POST

curl --location --request POST 'https://ind-ckyc.hyperverge.co/api/v1/config/upload' \
--header 'Content-Type: application/json' \
--header 'appId: <Enter_the_HyperVerge_appId>' \
--header 'appKey: <Enter_the_HyperVerge_appKey>' \
--header 'transactionId: <Enter_the_HyperVerge_transactionID>' \
--data '{
    "organisationName": "<Enter_the_Organisation_Name>",
    "fiCode": "<Enter_the_FI_Code>",
    "regionCode": "<Enter_the_Region_Code>",
    "webhookUrl": "<Enter_the_URL>",
    "username": "<Enter_the_username>",
    "password": "<Enter_the_password>",
    "host": "<Enter_the_IP_Address>"
}'

PUT

curl --location --request PUT 'https://ind-ckyc.hyperverge.co/api/v1/config/upload' \
--header 'Content-Type: application/json' \
--header 'appId: <Enter_the_HyperVerge_appId>' \
--header 'appKey: <Enter_the_HyperVerge_appKey>' \
--header 'transactionId: <Enter_the_HyperVerge_transactionID>' \
--data '{
    "organisationName": "<Enter_the_Organisation_Name>",
    "fiCode": "<Enter_the_FI_Code>",
    "regionCode": "<Enter_the_Region_Code>",
    "webhookUrl": "<Enter_the_URL>",
    "username": "<Enter_the_username>",
    "password": "<Enter_the_password>",
    "host": "<Enter_the_IP_Address>"
}'

Success Response

{
    "status": "success",
    "statusCode": "200",
    "result": true
}

Error Responses

Invalid FI Code

{
  "status": "failure",
  "statusCode": "400",
  "error": {
    "code": "ER_REQ_VALIDATE",
    "message": "fiCode should not be null or undefined"
  }
}

Invalid Region Code

{
  "status": "failure",
  "statusCode": "400",
  "error": {
    "code": "ER_REQ_VALIDATE",
    "message": "regionCode should not be null or undefined"
  }
}

Server Error

{
  "status": "failure",
  "statusCode": "500",
  "error": {
    "code": "ER_SERVER",
    "message": "internal server error"
  }
}

Error Response Details

Status Code	Error Code	Error Message	Error Description
400	ER_REQ_VALIDATE	"fiCode should not be null or undefined"	The request has null or undefined fiCode.
400	ER_REQ_VALIDATE	"regionCode should not be null or undefined"	The request has null or undefined regionCode.
500	ER_SERVER	"internal server error"	Kindly check the request headers or contact the HyperVerge team for resolution.